-
Notifications
You must be signed in to change notification settings - Fork 209
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Refactor snapshot tests to use helper functions #1844
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
olivroy
commented
Aug 19, 2024
gt() %>% | ||
tab_header( | ||
title = "TABLE TITLE", | ||
subtitle = "table subtitle" | ||
) %>% | ||
as_word(caption_location = "bottom") %>% | ||
expect_snapshot() | ||
expect_snapshot_word(gt_tbl_1, caption_location = "bottom") | ||
|
||
## basic table with title embedded on the top of table | ||
exibble_min %>% | ||
gt() %>% | ||
tab_header( | ||
title = "TABLE TITLE", | ||
subtitle = "table subtitle" | ||
) %>% | ||
as_word(caption_location = "embed") %>% | ||
expect_snapshot() | ||
expect_snapshot_word(gt_tbl_1, caption_location = "embed") | ||
|
||
## basic table with split enabled |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It was the same with different settings, hence the test simplification
rich-iannone
approved these changes
Aug 19, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
This was referenced Aug 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Changes in the snapshots is currently very painful to do due to an issue in testthat.
It seems that there are issues with updating snapshots when pipes
%>%
are present.This refactors the tests to use new helpers
expect_snapshot_html()
expect_snapshot_latex()
expect_snapshot_word()
expect_snapshot_rtf()
I used the following script to replace programatically the easiest ones.
Related GitHub Issues and PRs
Context, while working on #1842, it was difficult to iterate quickly as the snapshots were impossible to update via the usual way. I tried looking into #1837, but it proved challenging due to snapshot difficulties again.
Workaround r-lib/testthat#1646 and facilitate iteration. (Some people said that pipes were problematic)
Checklist
testthat
unit tests totests/testthat
for any new functionality.